home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / doink.zip / DOINK.DOC < prev    next >
Text File  |  1990-04-07  |  7KB  |  185 lines
  1.  
  2.  
  3.                           
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.                   ******    *****  **** **   ** **   **
  11.                   **   **  **   **  **  ***  ** **  **
  12.                   **    ** **   **  **  **** ** ** **
  13.                   **    ** **   **  **  ******* ****
  14.                   **    ** **   **  **  ** **** ** **
  15.                   **   **  **   **  **  **  *** **  ** 
  16.                   ******    *****  **** **   ** **   **
  17.  
  18.                     A QuickBBS Recent Caller Compiler
  19.  
  20.                          By Martin Rud Jakobsen
  21.  
  22.                Bondestrup BBS (+45)58286849, 300/1200&2400
  23.                
  24.                  Node 2:234/27  Mosquito Net Association 
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.                        TABLE OF CONTENTS
  38.                         -----------------
  39.  
  40. INTRODUCTION . . . . . . . . . . . . . . . . . . . . . . . . .  3
  41.  
  42. INSTALLATION . . . . . . . . . . . . . . . . . . . . . . . . .  4
  43.  
  44. CONFIGURING. . . . . . . . . . . . . . . . . . . . . . . . . .  5
  45.          The codes. . . . . . . . . . . . . . . . . . . . . . . .  5
  46.  
  47. COMMAND LINE PARAMETERS. . . . . . . . . . . . . . . . . . . .  7
  48.          Fill Character . . . . . . . . . . . . . . . . . . . . .  7
  49.          Pick Users . . . . . . . . . . . . . . . . . . . . . . .  7
  50.          Ways to start Doink. . . . . . . . . . . . . . . . . . .  7
  51.                          INTRODUCTION
  52.                           ------------
  53.  
  54.      Doink!!! Don't spend too much time wondering about the
  55.      name, just learn to pronounce it and live with it? ok?
  56.      So what's Doink anyway, you might ask. Doink is a
  57.      recent caller compiler created in the true spirit of
  58.      QuickBBS, and the true spirit is,, open architecture.
  59.      With Doink you will be able to insert the names of the
  60.      last 99 callers into your menus. And when I say 'into
  61.      your menus' i MEAN 'INTO YOUR MENUS'. Yes, by using
  62.      Doink you are now able to place the names EVERYWHERE in
  63.      the menus. Even with borders around the names! So what
  64.      are you waiting for? Go on and install the beast.
  65.  
  66.  
  67.                                        Have Fun (i did)
  68.  
  69.                                           Martin Rud Jakobsen
  70.                          INSTALLATION
  71.                           ------------
  72.  
  73. 1)     Place all the file 'DOINK.EXE' in a directory witch have a
  74.     PATH to it.
  75. 2)    Insert doink in your batchfile so it will be executed
  76.      everytime a user leaves your system. Doink don't need to be
  77.      executed in the same directory as it's configuration and
  78.      data files. But it need however, a PATH to them, including
  79.      the SYSINFO.BBS file. If you choose to execute Doink in the
  80.      same directory as all these files, no PATH are needed.
  81.  
  82.                           CONFIGURING
  83.                            -----------
  84.  
  85. Use an standard ASCII editor to create the file 'DOINK.CFG', a
  86. sample file have been included in the package as an example. In
  87. this file you state the drive, path and name of the menu text
  88. files that you wish to compile.
  89. here's an example:
  90. C:\bbs\txtfiles\WELCOME.AN0
  91. C:\bbs\txtfiles\WELCOME.ANS
  92. So what does this do? The first line tells which file to wish to
  93. get compiled and the second line tells which file the result
  94. should be stored in! There can be up to 30 of these 'sets' of
  95. files, if you want another file to be converted, just type in
  96. another 2 lines so Doink can find them.
  97. You may now have guessed that you have to insert some special
  98. codes in your menus. And here's how to do it.
  99.  
  100. The codes
  101. ---------
  102. There are 3 types of information for every caller,
  103. 1 name
  104. 2 time and date
  105. 3 The systems total amount of received calls.
  106.  
  107. the codes looks like this,
  108.  
  109. [$01N-------]        |this is for the name
  110. [$01T-------]        |this is for the date and time
  111. [$01C-------]        |this is for the systems received call nr.
  112.  
  113. These three parameters will be exchanged with the data concerning
  114. the last user online. so in the source file, you will see these
  115. codes, but in the final file, the users data, will be showed. The
  116. number just after '$' tells Doink which user that you want
  117. information about, it must ALWAYS be two digits, not one, not
  118. three but TWO(2) and in decimal. The number 1 represents the last
  119. user online, 2 for the second last user online and so on.The letter
  120. N,T or C tells Doink what kind of information that you want. The '-' is
  121. used for marking how long that you wish the information to fill,
  122. if it is longer, it will be truncated. If it is shorter a space
  123. will be inserted.  Remember to place a ']' in the end so doink 
  124. knows when to stop.
  125. You may NOT place ANSI codes in the parameters, because if Doink
  126. can't see them([$01x) in one piece, Doink will not begin to
  127. insert any user data and any ANSI codes before ] will be
  128. converted, so NO ANSI codes, please. This can be tricky to avoid,
  129. especially if you are using ANSI drawing program(like The Draw).
  130. I had a problem with The Draw when i tested this program. After i
  131. had compiled my menus, they looked 'screwed up'. the 'error' was
  132. that my menu was 80 chars. long so there were no <CR>. And The
  133. Draw inserts some ANSI codes for every 255 chars. if there's no
  134. <CR>, unless you tell it NOT to. So if you are using The Draw and
  135. there's something strange, in your menus, who do you call, NOT
  136. ME!!!! Try to choose 'None' when The Draw ask about max. line
  137. length. If it still looks a bit weird, the try using an ASCII
  138. editor to look at your ANSI file, then you will be able to see if
  139. there's any ANSI codes floating around.
  140.                     COMMAND LINE PARAMETERS
  141.                      -----------------------
  142.  
  143. Fill Character
  144. --------------
  145.     You may not want Doink to insert a space character( chr(32)),
  146. in the room left after the user data,but another character, then
  147. state the ASCII code of the character that you wish doink to use
  148. when you execute doink, like this,
  149. DOINK 66
  150. Now the ASCII character 66 will be used instead. 
  151.  
  152. Pick Users
  153. ----------
  154.     Some SysOp's don't like to see one user presented 10 times in
  155. their caller list because they rather want their list to
  156. represent a list of DIFFERENT users online lately. If YOU feel
  157. that way too then insert the letter 'p' (purge) and Doink will
  158. not remember the user if it was he QuickBBS serviced last time.
  159. Call Doink this way,
  160. DOINK P
  161.  
  162.  
  163. Ways to start Doink
  164. -------------------
  165.     You can start Doink in many different ways, here's some
  166. examples,
  167.  
  168. DOINK
  169. DOINK 32 P
  170. DOINK P
  171. DOINK 66
  172. DOINK P 34
  173.  
  174.  
  175. Now i hope that you with this document will be able to install
  176. and use DOINK. 
  177. The package should contain the following files.
  178.  
  179. DOINK.EXE             |The program
  180. DOINK.CFG             |A example of a configuration
  181. USERS.AS0             |A ASCII test screen.
  182. DOINK.DOC             |This document.
  183.  
  184. DOINK.CFG and DOINK.CFG have been included as an example only.
  185.